DescribeMetricList
Description
Call the DescribeMetricList interface to query the monitoring data of cloud product time series indicators within the specified time period.
Request Method
POST
Request Path
/apsara/route/cms/DescribeMetricList
Request Parameters Common Parameters
| Name | Location | Type | Required | Sample value | Description |
|---|---|---|---|---|---|
| MetricName | BODY | string | Yes | cpu_idle | monitoring item name. |
| Express | BODY | string | No | {"groupby":["userId","instanceId"]} | expression for real-time calculation of queried existing results. Currently only support groupby(similar to database groupby statement). |
| EndTime | BODY | string | No | 2019-01-30 00:10:00 | end time. Supported formats: Unix timestamp: the number of seconds elapsed from January 1, 1970. Format format: YYYY-MM-DDThh:mm:ssZ. |
| NextToken | BODY | string | No | 15761485350009dd70bb64cff1f0fff750b08ffff073be5fb1e785e2b020f1a949d5ea14aea7fed82f01dd87311 | paging cursor ID. description if this parameter is not passed in to indicate that the data on the first page is obtained, this parameter only needs to return to indicate that there is a next page. you can use the returned NextToken as a parameter to request the data on the next page again until null is returned to indicate that all the data has been obtained. |
| Length | BODY | string | No | 1000 | the number of records displayed on each page, used for paging query, the default value is 1000. |
| regionId | BODY | string | Yes | No sample value for this parameter. | region id |
| StartTime | BODY | string | No | 2019-01-30 00:00:00 | start time. Supported formats: Unix timestamp: the number of seconds elapsed from January 1, 1970. Format format: YYYY-MM-DDThh:mm:ssZ. Description The start and end times execute the left-on-right closed mode, and the startTime cannot be equal to or greater than the endTime. |
| Dimensions | BODY | string | No | [{"instanceId": "i-abcdefgh12****"}] | dimension map, which is used to query the monitoring data of specified resources. format key-value a collection of key-value pairs, commonly used key-value set as instanceId:XXXXXX. key and value has a length of 1~64 bytes, intercept the first 64 bytes when it exceeds 64 bytes. key and value can include letters, numbers, dots (.), hyphens (-), underscores (_), forward slashes (/), and backslashes (\). description Dimensions when passing in, a JSON string must be used to represent the Map object and must be passed in sequentially. |
| Period | BODY | string | No | 60 | time interval, in seconds. The values are generally 60(1 minute), 300(5 minutes), and 900(15 minutes). Description Please set this parameter as needed. For example, if the Period is set to 60 when querying the range of one day, 1000 pieces of data are returned (the actual 1440 exists, because the maximum return value does not exceed 1000, only the first 1000 pieces are returned). If Period is used as a 300, 288 pieces of data are returned. |
| version | BODY | string | No | 2016-01-01 | version of api |
| Namespace | BODY | string | Yes | acs_ecs_dashboard | The data namespace of the product is used to distinguish different products. Naming method: acs_product name. |
Return data
| Name | Type | Sample value | Description |
|---|---|---|---|
| RequestId | string | No sample value for this parameter. | request ID. |
| NextToken | string | No sample value for this parameter. | paging cursor ID. description if this parameter is not passed in to indicate that the data on the first page is obtained, this parameter only needs to return to indicate that there is a next page. you can use the returned NextToken as a parameter to request the data on the next page again until null is returned to indicate that all the data has been obtained. |
| Message | string | No sample value for this parameter. | error message. |
| Period | string | No sample value for this parameter. | Time interval, in seconds. The values are 60, 300 and 900. |
| Datapoints | string | No sample value for this parameter. | monitoring data list. |
| Code | string | No sample value for this parameter. | status code. description status code 200 indicates success. |
| Success | boolean | No sample value for this parameter. | whether the request was successful. |
Example
Successful Response example
"The successful response sample is not recognizable. Please modify API definition in API gateway before re-create the API document."
Failed Response example
{
"errorSample":
{
"resultCode":-1,
"resultMsg":"system error",
"result":null
}
}